<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>LibCDS: /home/zsshen/Desktop/git-hub-code/C-Common-Data-Structures/include/list/dlinked_list.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">LibCDS
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('dlinked__list_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">dlinked_list.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="dlinked__list_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * @file dlinked_list.h The doubly linked list.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#ifndef _DLINKED_LIST_H_</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define _DLINKED_LIST_H_</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &quot;../util.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">/** DListData is the data type for the container private information. */</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="dlinked__list_8h.html#a02f9a26c873c42cc73a3b87198908f24">   11</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_DListData <a class="code" href="dlinked__list_8h.html#a02f9a26c873c42cc73a3b87198908f24">DListData</a>;</div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">/** The implementation for doubly linked list. */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structDLinkedList.html">   14</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_DLinkedList {<span class="comment"></span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">    /** The container private information */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structDLinkedList.html#abcad07cf15e5eeda1a8adf4e46275610">   16</a></span>&#160;    <a class="code" href="dlinked__list_8h.html#a02f9a26c873c42cc73a3b87198908f24">DListData</a> *<a class="code" href="structDLinkedList.html#abcad07cf15e5eeda1a8adf4e46275610">pData</a>;</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">    /** Push an item to the head of the list.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">        @see DListPushFront */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structDLinkedList.html#a671561223355129e6545863e1528efb8">   20</a></span>&#160;    int32_t (*push_front) (<span class="keyword">struct </span>_DLinkedList*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>);</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">    /** Push an item to the tail of the list.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">        @see DListPushBack */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structDLinkedList.html#a712aeed41505b628144f53c097aef52d">   24</a></span>&#160;    int32_t (*push_back) (<span class="keyword">struct </span>_DLinkedList*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>);</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">    /** Insert an item to the designated index of the list.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">        @see DListInsert */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structDLinkedList.html#a27807ffe9ed6ee538c2c3578712406ef">   28</a></span>&#160;    int32_t (*insert) (<span class="keyword">struct </span>_DLinkedList*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>, int32_t);</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">    /** Pop an item from the head of the list.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">        @see DListPopFront */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structDLinkedList.html#a1327851ecce67df30fda92a8b02b34e8">   32</a></span>&#160;    int32_t (*pop_front) (<span class="keyword">struct </span>_DLinkedList*, bool);</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment">    /** Pop an item from the tail of the list.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">        @see DListPopBack */</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structDLinkedList.html#ad4f957eba9203c87c2cba42e531e2682">   36</a></span>&#160;    int32_t (*pop_back) (<span class="keyword">struct </span>_DLinkedList*, bool);</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">    /** Delete an item from the designated index of the list</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">        @see DListDelete */</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structDLinkedList.html#a5bf6b82f1af9cf6c44d7430c9b7f1b12">   40</a></span>&#160;    int32_t (*<span class="keyword">delete</span>) (<span class="keyword">struct </span>_DLinkedList*, int32_t, bool);</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">    /** Set an item at the head of the list.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">        @see DListSetFront */</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structDLinkedList.html#a2672dcb106774ffab2a0a181ab50850e">   44</a></span>&#160;    int32_t (*set_front) (<span class="keyword">struct </span>_DLinkedList*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>, bool);</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">    /** Set an item at the tail of the list.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">        @see DListSetBack */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structDLinkedList.html#a5daaea33b73e8867c9dd584aef85a6e3">   48</a></span>&#160;    int32_t (*set_back) (<span class="keyword">struct </span>_DLinkedList*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>, bool);</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">    /** Set an item at the designated index of the list.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">        @see DListSetAt */</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structDLinkedList.html#abbddfdbbfd81dbe0e334709c771067bf">   52</a></span>&#160;    int32_t (*set_at) (<span class="keyword">struct </span>_DLinkedList*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>, int32_t, bool);</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">    /** Get an item from the head of the list.</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">        @see DListGetFront */</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structDLinkedList.html#a6bcd0b4737f07d21212f7d4da34aadf4">   56</a></span>&#160;    int32_t (*get_front) (<span class="keyword">struct </span>_DLinkedList*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>*);</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment">    /** Get an item from the tail of the list.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment">        @see DListGetBack */</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structDLinkedList.html#a66357b7fbd938f482b4f0a8a638d72b8">   60</a></span>&#160;    int32_t (*get_back) (<span class="keyword">struct </span>_DLinkedList*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>*);</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">    /** Get an item from the designated index of the list.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">        @see DListGetAt */</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structDLinkedList.html#a426a686c88b2f3ebb933e5a408d5e8c3">   64</a></span>&#160;    int32_t (*get_at) (<span class="keyword">struct </span>_DLinkedList*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>*, int32_t);</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment">    /** Return the number of stored items.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment">        @see DListSize */</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="structDLinkedList.html#a5de1d12fbbbb39021974ecd99cbb1a5d">   68</a></span>&#160;    int32_t (*size) (<span class="keyword">struct </span>_DLinkedList*);</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment">    /** Reverse the list.</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment">        @see DListReverse */</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="structDLinkedList.html#aa3892e2060ad1ca25aa0fc421d1ce71a">   72</a></span>&#160;    int32_t (*reverse) (<span class="keyword">struct </span>_DLinkedList*);</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment">    /** Set the user defined item clean method.</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment">        @see DListSetDestroy */</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="structDLinkedList.html#ac0b8972cba04e40877ef7fccc27e4401">   76</a></span>&#160;    int32_t (*set_destroy) (<span class="keyword">struct </span>_DLinkedList*, void (*) (<a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>));</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;} <a class="code" href="structDLinkedList.html">DLinkedList</a>;</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment">/*===========================================================================*</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"> *             Definition for the exported member operations                 *</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"> *===========================================================================*/</span><span class="comment"></span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment"> * @brief The constructor for DLinkedList.</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment"> * @param ppObj         The double pointer to the to be constructed list</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for list construction</span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#abdfa4541d1e58552c49d1aed27842631">DListInit</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> **ppObj);</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment"> * @brief The destructor for DLinkedList.</span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment"> * If the knob is on, it also runs the resource clean method for all the items.</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment"> * @param ppObj         The double pointer to the to be destructed list</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="keywordtype">void</span> <a class="code" href="dlinked__list_8h.html#aae6963622c12bcf4d72744f38d1e7822">DListDeinit</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> **ppObj, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment"> * @brief Push an item to the head of the list.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment"> * @param item          The designated item</span></div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for list extension</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#add3e1c102d5c490ad545de0562219371">DListPushFront</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> item);</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment"> * @brief Push an item to the tail of the list.</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment"> * @param item          The designated item</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for list extension</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#a16d671081a47f418cab95b27e29c714d">DListPushBack</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> item);</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment"> * @brief Insert an item to the designated index of the list.</span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment"> * This function inserts an item to the designated index of the list and shifts</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment"> * the trailing items one position to the tail. The index can be positive or</span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment"> * negative, but its absolute value should be smaller than or equal to the list</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment"> * size.</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment"> * The operation supports both forward and backward indexing. For the former one,</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment"> * the list is traversed from the head to the tail. And for the later one, the</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment"> * direction is reversed.</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment"> * To illustrate the behavior, let N denote the list size. Thus for forward indexing</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment"> * , index (0) and index (N-1) point to the head and tail. And for backward indexing,</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment"> * index (-1) and index (-N) point to the list tail and head.</span></div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment"> * But no matter which indexing method is applied, the list always grows from the</span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment"> * head to the tail.</span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"> * @param item          The designated item</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment"> * @param iIdx          The designated index</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for list extension</span></div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment"> * @retval ERR_IDX      Out of range indexing</span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment"> * @note The absolute value of the index should be smaller than or equal to the</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment"> * list size.</span></div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#a049fbc59e2ec06b413499e0f6041c4e5">DListInsert</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> item, int32_t iIdx);</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment"> * @brief Pop an item from the head of the list.</span></div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment"> * This function removes an item from the head of the list. If the knob is on,</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment"> * it also runs the resource clean method for the removed item.</span></div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment"> * @retval ERR_IDX      Empty list</span></div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#a953ea5e8dbb979efbee5dd21fb17fc5c">DListPopFront</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment"> * @brief Pop an item from the tail of the list.</span></div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;<span class="comment"> * This function removes an item from the tail of the list. If the knob is on,</span></div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="comment"> * it also runs the resource clean method for the removed item.</span></div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="comment"> * @retval ERR_IDX      Empty list</span></div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#ad169e45fe0cec35a3cccfb8082621892">DListPopBack</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;<span class="comment"> * @brief Remove an item from the designated index of the list.</span></div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment"> * This function removes an item from the designated index of the list and shifts</span></div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="comment"> * the trailing items one position to the head. If the knob is on, it also runs</span></div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment"> * the resource clean method for the removed item.</span></div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment"> * The operation supports both forward and backward indexing. Let N denote the</span></div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment"> * list size and i denote the index.</span></div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment"> * For forward indexing, inequality 0 &lt;= i &lt; N must be fitted.</span></div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment"> * For backward indexing, inequality 0 &lt; i &lt;= -N must be fitted.</span></div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="comment"> * @param iIdx          The designated index</span></div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;<span class="comment"> * @retval ERR_IDX      Out of range indexing</span></div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#a80956794899b4b40680b33f2ea43e63f">DListDelete</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, int32_t iIdx, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;<span class="comment"> * @brief Set an item at the head of the list.</span></div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;<span class="comment"> * This function replaces the head item with the designated one. If the knob is</span></div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;<span class="comment"> * on, it also runs the resource clean method for the replaced item.</span></div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;<span class="comment"> * @param item          The designated item</span></div>
<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;<span class="comment"> * @retval ERR_IDX      Empty list</span></div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#ac6d148bfcc2f203fb4eea9e631478243">DListSetFront</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> item, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="comment"> * @brief Set an item at the tail of the list.</span></div>
<div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;<span class="comment"> * This function replaces the tail item with the designated one. If the knob is</span></div>
<div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;<span class="comment"> * on, it also runs the resource clean method for the replaced item.</span></div>
<div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;<span class="comment"> * @param item          The designated item</span></div>
<div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;<span class="comment"> * @retval ERR_IDX      Empty list</span></div>
<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#a28c2453e554662a85e164fa1ae127cc5">DListSetBack</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> item, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;<span class="comment"> * @brief Replace an item at the designated index of the list.</span></div>
<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;<span class="comment"> * This function replaces the item at the designated index with the designated</span></div>
<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;<span class="comment"> * one. If the knob is on, it also runs the resource clean method for the replaced</span></div>
<div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;<span class="comment"> * item.</span></div>
<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;<span class="comment"> * The operation supports both forward and backward indexing. Let N denote the</span></div>
<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;<span class="comment"> * list size and i denote the index.</span></div>
<div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;<span class="comment"> * For forward indexing, inequality 0 &lt;= i &lt; N must be fitted.</span></div>
<div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;<span class="comment"> * For backward indexing, inequality 0 &lt; i &lt;= -N must be fitted.</span></div>
<div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;<span class="comment"> * @param item          The designated item</span></div>
<div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;<span class="comment"> * @param iIdx          The designated index</span></div>
<div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;<span class="comment"> * @retval ERR_IDX      Out of range index</span></div>
<div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#a824ec731fadeec2479104b0ef7787725">DListSetAt</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> item, int32_t iIdx, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;<span class="comment"> * @brief Get an item from the head of the list.</span></div>
<div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;<span class="comment"> * @param pItem         The pointer to the returned item</span></div>
<div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;<span class="comment"> * @retval ERR_IDX      Empty list</span></div>
<div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;<span class="comment"> * @note If the exception occurs, the second parameter will be updated with NULL.</span></div>
<div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#a56295bc420e7261c08eb87fd1174fcb8">DListGetFront</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> *pItem);</div>
<div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;<span class="comment"> * @brief Get an item from the tail of the list.</span></div>
<div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;<span class="comment"> * @param pItem         The pointer to the returned item</span></div>
<div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;<span class="comment"> * @retval ERR_IDX      Empty list</span></div>
<div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;<span class="comment"> * @note If the exception occurs, the second parameter will be updated with NULL.</span></div>
<div class="line"><a name="l00287"></a><span class="lineno">  287</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#a38c099725c114ff53ab5d15a8b337223">DListGetBack</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> *pItem);</div>
<div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;<span class="comment"> * @brief Get an item from the designated index of the list.</span></div>
<div class="line"><a name="l00292"></a><span class="lineno">  292</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00293"></a><span class="lineno">  293</span>&#160;<span class="comment"> * The operation supports both forward and backward indexing. Let N denote the</span></div>
<div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;<span class="comment"> * list size and i denote the index.</span></div>
<div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;<span class="comment"> * For forward indexing, inequality 0 &lt;= i &lt; N must be fitted.</span></div>
<div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;<span class="comment"> * For backward indexing, inequality 0 &lt; i &lt;= -N must be fitted.</span></div>
<div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00299"></a><span class="lineno">  299</span>&#160;<span class="comment"> * @param pItem         The pointer to the returned item</span></div>
<div class="line"><a name="l00300"></a><span class="lineno">  300</span>&#160;<span class="comment"> * @param iIdx          The designated index</span></div>
<div class="line"><a name="l00301"></a><span class="lineno">  301</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00302"></a><span class="lineno">  302</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00303"></a><span class="lineno">  303</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;<span class="comment"> * @retval ERR_IDX      Out of range index</span></div>
<div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00306"></a><span class="lineno">  306</span>&#160;<span class="comment"> * @note If the exception occurs, the second parameter will be updated with NULL.</span></div>
<div class="line"><a name="l00307"></a><span class="lineno">  307</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00308"></a><span class="lineno">  308</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#acbc86549a7d1f6c6860c460e0ae0cdee">DListGetAt</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> *pItem, int32_t iIdx);</div>
<div class="line"><a name="l00309"></a><span class="lineno">  309</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00310"></a><span class="lineno">  310</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00311"></a><span class="lineno">  311</span>&#160;<span class="comment"> * @brief Return the number of stored items.</span></div>
<div class="line"><a name="l00312"></a><span class="lineno">  312</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00313"></a><span class="lineno">  313</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00314"></a><span class="lineno">  314</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00315"></a><span class="lineno">  315</span>&#160;<span class="comment"> * @return              The number of stored item</span></div>
<div class="line"><a name="l00316"></a><span class="lineno">  316</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00317"></a><span class="lineno">  317</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00318"></a><span class="lineno">  318</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#ae5c16f0e9f5fb3c2db132fc2f134a34d">DListSize</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>);</div>
<div class="line"><a name="l00319"></a><span class="lineno">  319</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00320"></a><span class="lineno">  320</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00321"></a><span class="lineno">  321</span>&#160;<span class="comment"> * @brief Reverse the list.</span></div>
<div class="line"><a name="l00322"></a><span class="lineno">  322</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00323"></a><span class="lineno">  323</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00324"></a><span class="lineno">  324</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00325"></a><span class="lineno">  325</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00326"></a><span class="lineno">  326</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00327"></a><span class="lineno">  327</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#a3b16ee8a3822d91f20e81f9c84d9f689">DListReverse</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>);</div>
<div class="line"><a name="l00328"></a><span class="lineno">  328</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00329"></a><span class="lineno">  329</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00330"></a><span class="lineno">  330</span>&#160;<span class="comment"> * @brief Set the user defined item clean method.</span></div>
<div class="line"><a name="l00331"></a><span class="lineno">  331</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00332"></a><span class="lineno">  332</span>&#160;<span class="comment"> * @param self          The pointer to the DLinkedList structure</span></div>
<div class="line"><a name="l00333"></a><span class="lineno">  333</span>&#160;<span class="comment"> * @param pFunc         The function pointer to the custom method</span></div>
<div class="line"><a name="l00334"></a><span class="lineno">  334</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00335"></a><span class="lineno">  335</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00336"></a><span class="lineno">  336</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00337"></a><span class="lineno">  337</span>&#160;int32_t <a class="code" href="dlinked__list_8h.html#a4ac72057d0940893ce0997168bfd9441">DListSetDestroy</a>(<a class="code" href="structDLinkedList.html">DLinkedList</a> *<span class="keyword">self</span>, <span class="keywordtype">void</span> (*pFunc) (<a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>));</div>
<div class="line"><a name="l00338"></a><span class="lineno">  338</span>&#160;</div>
<div class="line"><a name="l00339"></a><span class="lineno">  339</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="dlinked__list_8h_html_a049fbc59e2ec06b413499e0f6041c4e5"><div class="ttname"><a href="dlinked__list_8h.html#a049fbc59e2ec06b413499e0f6041c4e5">DListInsert</a></div><div class="ttdeci">int32_t DListInsert(DLinkedList *self, Item item, int32_t iIdx)</div><div class="ttdoc">Insert an item to the designated index of the list. </div></div>
<div class="ttc" id="dlinked__list_8h_html_a38c099725c114ff53ab5d15a8b337223"><div class="ttname"><a href="dlinked__list_8h.html#a38c099725c114ff53ab5d15a8b337223">DListGetBack</a></div><div class="ttdeci">int32_t DListGetBack(DLinkedList *self, Item *pItem)</div><div class="ttdoc">Get an item from the tail of the list. </div></div>
<div class="ttc" id="structDLinkedList_html_abcad07cf15e5eeda1a8adf4e46275610"><div class="ttname"><a href="structDLinkedList.html#abcad07cf15e5eeda1a8adf4e46275610">DLinkedList::pData</a></div><div class="ttdeci">DListData * pData</div><div class="ttdoc">The container private information. </div><div class="ttdef"><b>Definition:</b> <a href="dlinked__list_8h_source.html#l00016">dlinked_list.h:16</a></div></div>
<div class="ttc" id="dlinked__list_8h_html_ae5c16f0e9f5fb3c2db132fc2f134a34d"><div class="ttname"><a href="dlinked__list_8h.html#ae5c16f0e9f5fb3c2db132fc2f134a34d">DListSize</a></div><div class="ttdeci">int32_t DListSize(DLinkedList *self)</div><div class="ttdoc">Return the number of stored items. </div></div>
<div class="ttc" id="dlinked__list_8h_html_a80956794899b4b40680b33f2ea43e63f"><div class="ttname"><a href="dlinked__list_8h.html#a80956794899b4b40680b33f2ea43e63f">DListDelete</a></div><div class="ttdeci">int32_t DListDelete(DLinkedList *self, int32_t iIdx, bool bClean)</div><div class="ttdoc">Remove an item from the designated index of the list. </div></div>
<div class="ttc" id="dlinked__list_8h_html_a02f9a26c873c42cc73a3b87198908f24"><div class="ttname"><a href="dlinked__list_8h.html#a02f9a26c873c42cc73a3b87198908f24">DListData</a></div><div class="ttdeci">struct _DListData DListData</div><div class="ttdoc">DListData is the data type for the container private information. </div><div class="ttdef"><b>Definition:</b> <a href="dlinked__list_8h_source.html#l00011">dlinked_list.h:11</a></div></div>
<div class="ttc" id="dlinked__list_8h_html_aae6963622c12bcf4d72744f38d1e7822"><div class="ttname"><a href="dlinked__list_8h.html#aae6963622c12bcf4d72744f38d1e7822">DListDeinit</a></div><div class="ttdeci">void DListDeinit(DLinkedList **ppObj, bool bClean)</div><div class="ttdoc">The destructor for DLinkedList. </div></div>
<div class="ttc" id="dlinked__list_8h_html_ac6d148bfcc2f203fb4eea9e631478243"><div class="ttname"><a href="dlinked__list_8h.html#ac6d148bfcc2f203fb4eea9e631478243">DListSetFront</a></div><div class="ttdeci">int32_t DListSetFront(DLinkedList *self, Item item, bool bClean)</div><div class="ttdoc">Set an item at the head of the list. </div></div>
<div class="ttc" id="dlinked__list_8h_html_a56295bc420e7261c08eb87fd1174fcb8"><div class="ttname"><a href="dlinked__list_8h.html#a56295bc420e7261c08eb87fd1174fcb8">DListGetFront</a></div><div class="ttdeci">int32_t DListGetFront(DLinkedList *self, Item *pItem)</div><div class="ttdoc">Get an item from the head of the list. </div></div>
<div class="ttc" id="dlinked__list_8h_html_add3e1c102d5c490ad545de0562219371"><div class="ttname"><a href="dlinked__list_8h.html#add3e1c102d5c490ad545de0562219371">DListPushFront</a></div><div class="ttdeci">int32_t DListPushFront(DLinkedList *self, Item item)</div><div class="ttdoc">Push an item to the head of the list. </div></div>
<div class="ttc" id="dlinked__list_8h_html_a28c2453e554662a85e164fa1ae127cc5"><div class="ttname"><a href="dlinked__list_8h.html#a28c2453e554662a85e164fa1ae127cc5">DListSetBack</a></div><div class="ttdeci">int32_t DListSetBack(DLinkedList *self, Item item, bool bClean)</div><div class="ttdoc">Set an item at the tail of the list. </div></div>
<div class="ttc" id="dlinked__list_8h_html_a3b16ee8a3822d91f20e81f9c84d9f689"><div class="ttname"><a href="dlinked__list_8h.html#a3b16ee8a3822d91f20e81f9c84d9f689">DListReverse</a></div><div class="ttdeci">int32_t DListReverse(DLinkedList *self)</div><div class="ttdoc">Reverse the list. </div></div>
<div class="ttc" id="dlinked__list_8h_html_a824ec731fadeec2479104b0ef7787725"><div class="ttname"><a href="dlinked__list_8h.html#a824ec731fadeec2479104b0ef7787725">DListSetAt</a></div><div class="ttdeci">int32_t DListSetAt(DLinkedList *self, Item item, int32_t iIdx, bool bClean)</div><div class="ttdoc">Replace an item at the designated index of the list. </div></div>
<div class="ttc" id="dlinked__list_8h_html_acbc86549a7d1f6c6860c460e0ae0cdee"><div class="ttname"><a href="dlinked__list_8h.html#acbc86549a7d1f6c6860c460e0ae0cdee">DListGetAt</a></div><div class="ttdeci">int32_t DListGetAt(DLinkedList *self, Item *pItem, int32_t iIdx)</div><div class="ttdoc">Get an item from the designated index of the list. </div></div>
<div class="ttc" id="util_8h_html_a2583da5c1c14184068bda8cf681d5bed"><div class="ttname"><a href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a></div><div class="ttdeci">const void * Item</div><div class="ttdoc">Item is the data type for the container element. </div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00030">util.h:30</a></div></div>
<div class="ttc" id="dlinked__list_8h_html_a4ac72057d0940893ce0997168bfd9441"><div class="ttname"><a href="dlinked__list_8h.html#a4ac72057d0940893ce0997168bfd9441">DListSetDestroy</a></div><div class="ttdeci">int32_t DListSetDestroy(DLinkedList *self, void(*pFunc)(Item))</div><div class="ttdoc">Set the user defined item clean method. </div></div>
<div class="ttc" id="dlinked__list_8h_html_ad169e45fe0cec35a3cccfb8082621892"><div class="ttname"><a href="dlinked__list_8h.html#ad169e45fe0cec35a3cccfb8082621892">DListPopBack</a></div><div class="ttdeci">int32_t DListPopBack(DLinkedList *self, bool bClean)</div><div class="ttdoc">Pop an item from the tail of the list. </div></div>
<div class="ttc" id="structDLinkedList_html"><div class="ttname"><a href="structDLinkedList.html">DLinkedList</a></div><div class="ttdoc">The implementation for doubly linked list. </div><div class="ttdef"><b>Definition:</b> <a href="dlinked__list_8h_source.html#l00014">dlinked_list.h:14</a></div></div>
<div class="ttc" id="dlinked__list_8h_html_a16d671081a47f418cab95b27e29c714d"><div class="ttname"><a href="dlinked__list_8h.html#a16d671081a47f418cab95b27e29c714d">DListPushBack</a></div><div class="ttdeci">int32_t DListPushBack(DLinkedList *self, Item item)</div><div class="ttdoc">Push an item to the tail of the list. </div></div>
<div class="ttc" id="dlinked__list_8h_html_abdfa4541d1e58552c49d1aed27842631"><div class="ttname"><a href="dlinked__list_8h.html#abdfa4541d1e58552c49d1aed27842631">DListInit</a></div><div class="ttdeci">int32_t DListInit(DLinkedList **ppObj)</div><div class="ttdoc">The constructor for DLinkedList. </div></div>
<div class="ttc" id="dlinked__list_8h_html_a953ea5e8dbb979efbee5dd21fb17fc5c"><div class="ttname"><a href="dlinked__list_8h.html#a953ea5e8dbb979efbee5dd21fb17fc5c">DListPopFront</a></div><div class="ttdeci">int32_t DListPopFront(DLinkedList *self, bool bClean)</div><div class="ttdoc">Pop an item from the head of the list. </div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0aa88ba44bbec23a6de57be31686ecf8.html">list</a></li><li class="navelem"><a class="el" href="dlinked__list_8h.html">dlinked_list.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
